Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User Guide for from_file function #1047

Open
wants to merge 45 commits into
base: main
Choose a base branch
from
Open

Conversation

rajeeja
Copy link
Contributor

@rajeeja rajeeja commented Oct 29, 2024

Users guide for using from_file GRID function #946

@rajeeja rajeeja self-assigned this Oct 29, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@rajeeja rajeeja mentioned this pull request Oct 29, 2024
@philipc2
Copy link
Member

Do you have any files from climate models or similar that you should showcase in this notebook? I'm not sure if showcasing the multipoly.shp is relevant to our users, as it isn't a proper grid.

@rajeeja
Copy link
Contributor Author

rajeeja commented Oct 29, 2024

Do you have any files from climate models or similar that you should showcase in this notebook? I'm not sure if showcasing the multipoly.shp is relevant to our users, as it isn't a proper grid.

yes, this PR is work in progress. I'll make it a draft.

@rajeeja rajeeja changed the title User Guide for from_file function DRAFT: User Guide for from_file function Oct 29, 2024
rajeeja and others added 22 commits October 31, 2024 15:14
o Remove the multipoly example, the old bug still exists, but that can be handled in issue #1048
@rajeeja
Copy link
Contributor Author

rajeeja commented Nov 18, 2024

image

What about the following title & description?

Title

Reading & Working with Geometry Files

Description

Load and work with geometry files (i.e. Shapefile, GeoJSON)

Is GIS more accurate? (it's gray area as we may also call it geometry in the sense that they store spatial data, such as the shapes, boundaries, and locations of features on the Earth’s surface.

@philipc2
Copy link
Member

image
What about the following title & description?

Title

Reading & Working with Geometry Files

Description

Load and work with geometry files (i.e. Shapefile, GeoJSON)

Is GIS more accurate? (it's gray area as we may also call it geometry in the sense that they store spatial data, such as the shapes, boundaries, and locations of features on the Earth’s surface.

It might be a bit more accurate, but GIS seems pretty outside of the scope of our package.

@rajeeja
Copy link
Contributor Author

rajeeja commented Nov 27, 2024

image
What about the following title & description?

Title

Reading & Working with Geometry Files

Description

Load and work with geometry files (i.e. Shapefile, GeoJSON)

Is GIS more accurate? (it's gray area as we may also call it geometry in the sense that they store spatial data, such as the shapes, boundaries, and locations of features on the Earth’s surface.

It might be a bit more accurate, but GIS seems pretty outside of the scope of our package.

Ok, since we explicitly call the formats, I have changed it to geometry files "Shapefile, GeoJSON"

@rajeeja rajeeja requested a review from aaronzedwick December 17, 2024 21:30
Copy link
Member

@aaronzedwick aaronzedwick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you forgot to clear the cell output and restart the kernel of the notebook before pushing the changes. Also, there seems to be an error in the docs.

@rajeeja
Copy link
Contributor Author

rajeeja commented Jan 10, 2025

I think you forgot to clear the cell output and restart the kernel of the notebook before pushing the changes. Also, there seems to be an error in the docs.

Thanks, yes. I'm looking to fix this.

Copy link

review-notebook-app bot commented Jan 10, 2025

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2025-01-10T23:58:00Z
----------------------------------------------------------------

I would suggest simplifying the introduction to the following (can exclude the first half):

This notebooks demonstrates how to use the Grid.from_file() class method to load in geometry files such as:

  1. Shapefile
  2. GeoJSON

Highlighted is a workflow showcasing how to remap a variable from an unstructured grid to a Shapefile.


Copy link

review-notebook-app bot commented Jan 10, 2025

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2025-01-10T23:58:00Z
----------------------------------------------------------------

Please refer to the from_file function as Grid.from_file()


Copy link

review-notebook-app bot commented Jan 10, 2025

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2025-01-10T23:58:01Z
----------------------------------------------------------------

Grid.from_file()


Copy link

review-notebook-app bot commented Jan 10, 2025

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2025-01-10T23:58:02Z
----------------------------------------------------------------

Check the markdown heading; the size appears to be off. Please make sure the following is applied throughout:

  • "#": Only used for the title
  • "##" Used for major headings (such as this one)
  • "###" Used for any smaller sub-headings.

Copy link
Member

@philipc2 philipc2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notebook looks great. Mostly formatting comments below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants